<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/persistent_mq_handle.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_0c017496b493ff066fbbe686970307ba.html">transport</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">persistent_mq_handle.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="persistent__mq__handle_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment">// Not compiled: for documentation only.  Contains concept docs as of this writing.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#ifndef IPC_DOXYGEN_ONLY</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="keyword">static_assert</span>(<span class="keyword">false</span>, <span class="stringliteral">&quot;As of this writing this is a documentation-only \&quot;header\&quot; &quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>                       <span class="stringliteral">&quot;(the \&quot;source\&quot; is for humans and Doxygen only).&quot;</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#else </span><span class="comment">// ifdef IPC_DOXYGEN_ONLY</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport.html">ipc::transport</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"></span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">/**</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * A documentation-only *concept* defining the behavior of an object representing a light-weight handle</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * to a message queue, capable of receiving/sending discrete messages in non-blocking/blocking/timed-blocking</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * fashion, as well as some support for polling/waiting and interruptions thereof.  The message queue (MQ)</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * is assumed to be of at least kernel persistence, meaning a handle to an MQ</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * closing does not delete the MQ, and another handle may reattach to it; in order to delete the underlying MQ</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * a separate remove op is needed (and is provided as well as a `static` method).</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> *</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * ### How to use ###</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * The following are relevant operations to do with MQs.  (Read Rationale for background.)</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> *   - Create (named) MQ: Persistent_mq_handle() ctor, with either util::Create_only or util::Open_or_create tag arg.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *     A Shared_name specifies the name.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> *     If one does not need a handle simply destroy the resulting object: the underlying created MQ continues existing.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *   - Create handle to the (named) MQ: Persistent_mq_handle() ctor, with either util::Open_only or</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *     util::Open_or_create tag arg.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *     A Shared_name specifies the name.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *   - Send message into the MQ, via handle: try_send() (non-blocking), send() (blocking), timed_send() (blocking with</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *     timeout).</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *     - Await writability without writing: is_sendable() (instant poll), wait_sendable() (blocking),</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *       timed_wait_sendable() (blocking with timeout).</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *     - Interrupt and/or preempt all above blocking operations including concurrently/preempt is_sendable():</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *       interrupt_sends().  Undo: allow_sends().</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> *   - Receive message out of the MQ, via handle: try_receive() (non-blocking), receive() (blocking),</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *     timed_receive() (blocking with timeout).</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *     - Await readability without reading: is_receivable() (instant poll), wait_receivable() (blocking),</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *       timed_wait_receivable() (blocking with timeout).</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> *     - Interrupt and/or preempt all above blocking operations including concurrently/preempt is_receivable():</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *       interrupt_receives().  Undo: allow_receives().</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> *   - Destroy handle to the MQ: ~Persistent_mq_handle() destructor.  The underlying MQ continues existing.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> *   - Destroy (named) MQ: remove_persistent().  Underlying MQ name disappears, but MQ continues existing until</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> *     all handles machine-wide are closed.  A Shared_name specifies the name.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * Concurrent ops safe on different objects (including when the same-named queue is being accessed).</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * Concurrent non-`const` ops (where at least 1 is non-`const`) not safe on the same `*this`.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> *</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * The notable exception to the latter: each of `interrupt_*()` and `allow_*()` is safe to call on the same</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * `*this` concurrently to any method except `interrupt_*()` and `allow_*()` themselves.  In fact</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * `interrupt_*()` ability to interrupt a concurrent timed-waiting of infinitely-waiting read or write is</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * most of those methods&#39; utility.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * ### Rationale ###</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * Here&#39;s why this concept exists and how it was designed to be the way it is.  It&#39;s actually quite simple;</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * the only question is why it is this way and not some other way.  Update: It&#39;s somewhat less simple now but not bad.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * ipc::transport features the Blob_sender and Blob_receiver concepts, each of which is a peer endpoint of a</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * connected one-way pipe capable of transmitting discrete messages, each consisting of a binary blob.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * They are first-class citizens of ipc::transport, or at least of its core-layer portion, meaning they&#39;re likely</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * to be used by the user directly or at least in highly visible fashion by another aspect of ipc::transport impl.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * They have a vaguely socket-like API, with an asynchronous receive method and a convenient non-blocking/synchronous</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * sender method (that cannot yield would-block).  Lastly the destructor of either ensures the underlying transport</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * cannot be used again by somehow opening another handle to the same thing.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * One implementation of Blob_sender and Blob_receiver simultaneously might be Native_socket_stream which</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * uses Unix domain stream connection as underlying transport.  That one is a natural fit for the concept,</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * including the fact that closing a Unix domain socket hoses the connection entirely (one cannot somehow &quot;reattach&quot;</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * to it).  It&#39;s good.  However, benchmark tests (details omitted) show that, when need not also send native handles</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * over such a connection, *message queue* low-level transports might be more performant or at least competitive.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * In our ecosystem, two message queue (MQ) transports are candidates: the POSIX message queue (provided by Linux)</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * (see `man mq_overview`) and the boost.interprocess (bipc) message queue (web-search for</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * `boost::interprocess::message_queue`).  We wanted to support both and then provide the choice of which one to use.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * So the goal is to write Blob_sender and Blob_receiver concept impls for each type of MQ (and possibly others</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * over time).  So how to do that nicely?</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> *</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * The 2 low-level MQ APIs (POSIX MQ and bipc MQ) are extremely different, conceptually and in practice, from</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * stream socket APIs of any kind.  For one thing, the MQs have kernel persistence -- they&#39;re like files in memory that</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> * disappear at reboot but otherwise stay around, so one can reattach a handle to one even after closing another one;</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * and deleting it is a separate operation not involving any handle.  For another, they don&#39;t use socket-descriptors</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * and hence do not participate in `epoll/poll/select()` mechanisms and feature only blocking, non-blocking, and</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * blocking-with-timeout send and receive APIs.  (POSIX MQ does have `mq_notify()`, but this async-notify mechanism</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * is quite limited, either creating a new thread for each notification, or using a signal.  POSIX MQ in Linux</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * *does* happen to have a non-portable property wherein the descriptor is really an FD, so it *can* participate</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * in `epoll/poll/select()` mechanisms; and boost.asio *does* have a `posix::descriptor` that can wrap such a</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * native descriptor.  However: bipc MQ lacks anything like this at all.)</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * The 2 APIs are, however, extremely similar to each other.  In fact, one gets the impression that the authors</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * of bipc MQ considered wrapping POSIX MQs but reconsidered for whatever reason (maybe the obscure limit semantics,</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * lack of availability in all Linux versions and other Unixes and Windows) -- but fairly closely mirrored the API</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * therein.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * Knowing this, it looked pretty natural to write some Blob_sender/Blob_receiver impls holding</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * some `bipc::message_queue` handles internally.  However, while conceptually similar, the POSIX MQ API is a</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * C API, not a Boost-style C++ thing.  It would be entirely possible to still write Blob_sender/Blob_receiver impls</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * around this API, but since conceptually it&#39;s so similar to bipc MQ, why waste the effort?  Code reuse for the win.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> *</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * That brings us to this concept.  What it is is: A thing I (ygoldfel) came up with by simply taking</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> * `bipc::message_queue` and working backwards, making a concept for an MQ handle, Persistent_mq_handle, to which</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * `bipc::message_queue` directly conforms already in most key ways (to wit: the send/receive methods).</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * Then one could write a very thin non-polymorphic HAS-A wrapper class (with no added data stored) and a couple other</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * utility functions with very thin adaptations to match ipc::transport style (like using Shared_name instead of</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * strings when creating or removing kernel-persistent queue instances).  This class is Bipc_mq_handle; it</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * implements this Persistent_mq_handle.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> *</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> * Next, a class can be written to mirror this API but for POSIX MQs.  This is a little harder, since it can&#39;t just</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> * expose some existing super-class&#39;s send/receive functions, but it would just wrap the Linux C API and store</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> * an MQ handle; done.  This class is Posix_mq_handle; it also implements Persistent_mq_handle.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> * Now that Persistent_mq_handle provides a uniform API, a Blob_sender/Blob_receiver can be written around a</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * `typename Persistent_mq_handle` which can be either Bipc_mq_handle or Posix_mq_handle (or a future wrapper around</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * something else).</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> * ### Poll/wait and interrupt facilities ###</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * Somewhat later we added a major feature to the concept (and both known impls): For each type of transmission</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * operation in a given direction (instant poll, blocking, blocking with timeout), there is a poll/wait counterpart</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> * which is almost the same except it does not actually transmit but merely returns the fact transmission</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> * is possible.  E.g., try_receive() &lt;=&gt; is_receivable(), receive() &lt;=&gt; wait_receivable(),</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> * timed_receive() &lt;=&gt; timed_wait_receivable().  In fact -- in the absence of a competing `*this` --</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> * receive() = wait_receivable() + try_receive() (succeeds), timed_receive() = timed_wait_receivable() + try_receive()</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> * (succeeds).</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> * This is useful at least in that it allows one to defer deciding on a target buffer for receiving, until</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> * receiving would (probably) actually work.  In the other direction it can still provide useful flexibility in</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> * a multi-threaded setup (one thread blockingly-waits, the other is signaled about readiness and tries to</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> * transmit but without blocking -- useful in a thread U/thread W setup).</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> * Lastly, any blocking (with or without timeout) can be interrupted via the `interrupt_*()` methods.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> * For example a receive() or wait_receivable() may be ongoing in thread W, and thread U can interrupt_receives()</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * to immediately make the blocking op exit with error::Code::S_INTERRUPTED.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> * ### Discussion: The road to boost.asio-like async I/O ###</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * What would be cool, which isn&#39;t here, is if this concept described a boost.asio I/O object, capable of plugging</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * into a boost.asio loop; or ~equivalently something a-la Blob_sender and/or Blob_receiver.  However that was not</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * our aim -- we only want a thin wrapper as noted in &quot;Rationale&quot; above -- and Blob_stream_mq_receiver and</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * Blob_stream_mq_sender achieve it (and arguably more -- albeit with the limit of a single writer and single reader).</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * That said: it may be useful to contemplate what parts the concept does have that are conducive to that type of work.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> *</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * Without the poll/wait facilities combined with interrupt facilities, it was possible but somewhat clunky,</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * having to at least start a background thread in which to perform blocking transmit calls; they&#39;d have to</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> * be broken up into subject-to-timeout shorter calls, so that the thread could be stopped and joined during</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * deinit.  Even then full deinit could only occur with a potential pause until the current short call in the</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * background thread W could return.  By having thread W do (indefinite) waits only, and allowing thread U to</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> * do non-blocking transmits only *and* `interrupt_*()`, we achieve pretty good flexibility and responsiveness.</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * That is what Blob_stream_mq_sender and Blob_stream_mq_receiver can do given the present concept.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> *</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * However -- it *can* be more advanced still.  Consider the specific impl Posix_mq_handle, which has the</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> * additional-to-concept (edit: see below update) method Posix_mq_handle::native_handle(); in Linux a #Native_handle.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> * This can be waited-on, natively with `[e]poll*()`; with boost.asio via util::sync_io::Asio_waitable_native_handle</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> * (more or less a `boost::asio::posix::descriptor`).  *Now* no background thread W is necessary: thread U</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> * can ask the *kernel* to report readability/writability -- when active it can do non-blocking stuff.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> * The wrinkle: Posix_mq_handle has it; but Bipc_mq_handle does not (and there is no FD inside its impl either;</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * it is fully SHM-based internally).  Can it be generalized nevertheless?  Yes and no.  Yes: in that it can be</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> * simulated by &quot;secretly&quot; having a thread W and having it use a pipe (or something) to translate readable/writable</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> * events into a live FD that could be detected via `[e]poll*()` or boost.asio.  No: in that it turns a</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> * hypothetical Persistent_mq_handle impl, namely Bipc_mq_handle, into something complex as opposed to any kind</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> * of thin wrapper around an MQ API.  Therefore we did not do it.</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> * However -- we did ~such a thing with sync_io::Blob_stream_mq_sender and sync_io::Blob_stream_mq_receiver which</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> * are templated on Persistent_mq_handle as a template-parameter; and, being</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * `sync_io`-pattern-impls (see util::sync_io), they each expose a waitable-on #Native_handle.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> * Indeed as of this writing each of these templates keeps a &quot;secret&quot; thread W that performs</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> * blocking waits, while the user-accessible API makes it look like a nice, kernel-reported-via-FDs</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> * reactor/proactor-supporting I/O object.  By operating on what is directly available via the present concept,</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> * this setup of Blob_stream_mq_sender and Blob_stream_mq_receiver internals is agnostic to the type of MQ.</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> *</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * However, if one wanted to take advantage of the non-concept (edit: see below update) ability to be watched</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * (via FD) with the kernel&#39;s help and without an added thread, they could specialize `Blob_stream_mq_*er`</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * for Posix_mq_handle which does offer a kernel-FD accessor `.native_handle()`.  Update: This is now done</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> * (in fact it is not specialized as of this writing but rather uses a few simple `if constexpr</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * ()`s).  Accordingly the concept now allows for `native_handle()` optionally: see</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * Persistent_mq_handle::S_HAS_NATIVE_HANDLE.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> */</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html">  194</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> <span class="comment">// Note: movable but not copyable.</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>{</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"></span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment">  /// Shared_name relative-folder fragment (no separators) identifying this resource type.</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ad49e1049101a5ab6cfb2ed2b3eaedee0">  200</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ad49e1049101a5ab6cfb2ed2b3eaedee0">S_RESOURCE_TYPE_ID</a>;</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"></span> </div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment">  /// `true` if and only if native_handle() method exists, and the returned value may be waited-on by `poll()`/etc.</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac2c0b560893c6a8b71aac0e748770076">  203</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac2c0b560893c6a8b71aac0e748770076">S_HAS_NATIVE_HANDLE</a> = unspecified;</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span> </div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"></span> </div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   * Construct null handle, suitable only for being subsequently moved-to or destroyed.</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   * If you do anything on `*this`, other than invoking dtor or move-assignment, behavior is undefined.</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   */</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a22abfaa801a9e2f974a8cd179544d19a">  211</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a22abfaa801a9e2f974a8cd179544d19a">Persistent_mq_handle</a>();</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"></span> </div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">   * Construct handle to non-existing named MQ, creating it first.  If it already exists, it is an error.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment">   * If an error is emitted via `*err_code`, and you do anything on `*this` other than invoking dtor or</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment">   * move-assignment, behavior is undefined.</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment">   *</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">   * @param absolute_name</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">   *        Absolute name at which the persistent MQ lives.</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   * @param mode_tag</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   *        API-choosing tag util::CREATE_ONLY.</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   * @param perms</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   *        Permissions to use for creation.  Suggest the use of util::shared_resource_permissions() to translate</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   *        from one of a small handful of levels of access; these apply almost always in practice.</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   *        The applied permissions shall *ignore* the process umask and shall thus exactly match `perms`,</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   *        unless an error occurs.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   * @param max_n_msg</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">   *        Max # of unpopped messages in created queue.</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">   * @param max_msg_sz</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">   *        Max # of bytes in any one message in created queue.</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   *        various.  Most likely creation failed due to permissions, or it already existed.</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   */</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a341076bd3ac7e32e4d1fa12570a11fd2">  237</a></span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a341076bd3ac7e32e4d1fa12570a11fd2">Persistent_mq_handle</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">absolute_name</a>,</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span>                                <a class="code hl_typedef" href="namespaceipc_1_1util.html#a9d84c2bab504e6de32b20c77ca9723a2">util::Create_only</a> mode_tag, <span class="keywordtype">size_t</span> max_n_msg, <span class="keywordtype">size_t</span> max_msg_sz,</div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span>                                <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">util::Permissions</a>&amp; perms = <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">util::Permissions</a>(),</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span>                                <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment"></span> </div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   * Construct handle to existing named MQ, or else if it does not exist creates it first and opens it (atomically).</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   * If an error is emitted via `*err_code`, and you do anything on `*this` other than invoking dtor or</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   * move-assignment, behavior is undefined.</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   *</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   * @param absolute_name</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   *        Absolute name at which the persistent MQ lives.</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   * @param mode_tag</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   *        API-choosing tag util::OPEN_OR_CREATE.</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   * @param perms_on_create</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   *        Permissions to use if creation is required.  Suggest the use of util::shared_resource_permissions() to</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   *        translate from one of a small handful of levels of access; these apply almost always in practice.</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   *        The applied permissions shall *ignore* the process umask and shall thus exactly match `perms_on_create`,</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   *        unless an error occurs.</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * @param max_n_msg_on_create</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   *        Max # of unpopped messages in created queue if creation is required.</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   * @param max_msg_sz_on_create</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   *        Max # of bytes in any one message in created queue if creation is required.</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">   *        various.  Most likely creation failed due to permissions.</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   */</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af20035c875572ed018427322c845b9f9">  266</a></span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af20035c875572ed018427322c845b9f9">Persistent_mq_handle</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">absolute_name</a>,</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span>                                <a class="code hl_typedef" href="namespaceipc_1_1util.html#a9571de958538d7a4a8649bbfecfac0b9">util::Open_or_create</a> mode_tag, <span class="keywordtype">size_t</span> max_n_msg_on_create, <span class="keywordtype">size_t</span> max_msg_sz_on_create,</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span>                                <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">util::Permissions</a>&amp; perms_on_create = <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">util::Permissions</a>(),</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span>                                <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment"></span> </div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment">   * Construct handle to existing named MQ.  If it does not exist, it is an error.</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment">   * If an error is emitted via `*err_code`, and you do anything on `*this` other than invoking dtor or</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">   * move-assignment, behavior is undefined.</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   *</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   * @param absolute_name</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   *        Absolute name at which the persistent MQ lives.</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   * @param mode_tag</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   *        API-choosing tag util::OPEN_ONLY.</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   *        various.  Most likely it already existed.</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   */</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af74d564d34874d1b86c043dfb7406048">  286</a></span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af74d564d34874d1b86c043dfb7406048">Persistent_mq_handle</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">absolute_name</a>,</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span>                                <a class="code hl_typedef" href="namespaceipc_1_1util.html#a3e03491b5b2b5fac26551a220946d6e5">util::Open_only</a> mode_tag, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment"></span> </div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * Constructs handle from the source handle while making the latter invalid.</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   * If you do anything on `src` after this, other than invoking dtor or move-assignment, behavior is undefined.</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   *</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * Informally: this is a light-weight op.</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   *</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   *        Source object which is nullified.</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   */</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a65d294e8972436e1193fe02baa34b20d">  298</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a65d294e8972436e1193fe02baa34b20d">Persistent_mq_handle</a>(<a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp;&amp; src);</div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment"></span> </div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">  /// Copying of handles is prohibited.</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae58b5d8b275dc364a0abeaf36c6a4534">  301</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae58b5d8b275dc364a0abeaf36c6a4534">Persistent_mq_handle</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment"></span> </div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   * Destroys this handle (or no-op if no handle was successfully constructed, or if it&#39;s a moved-from or default-cted</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   * handle).  The underlying MQ (if any) is *not* destroyed and can be attached-to by another handle.</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   */</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a1fbb936f8f80fedcb1227794ef0a451b">  307</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a1fbb936f8f80fedcb1227794ef0a451b">~Persistent_mq_handle</a>();</div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span> </div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment"></span> </div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   * Replaces handle with the source handle while making the latter invalid.</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   * If you do anything on `src` after this, other than invoking dtor or move-assignment, behavior is undefined.</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   *</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   * Informally: this is a light-weight op.</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   *</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   *        Source object which is nullified.</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   */</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a30b2d1fdc3cae55c9c1fe8a1014247ff">  321</a></span>  <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a30b2d1fdc3cae55c9c1fe8a1014247ff">operator=</a>(<a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp;&amp; src);</div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment"></span> </div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">  /// Copying of handles is prohibited.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af19038ecd7b1ab5b579d011345cef62b">  324</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af19038ecd7b1ab5b579d011345cef62b">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment"></span> </div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   * Removes the named persistent MQ.  The name `name` is removed from the system immediately; and</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">   * the function is non-blocking.  However the underlying MQ if any continues to exist until all handles to it are</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   * closed; their presence in this or other process is *not* an error.</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   *</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   * @see `util::remove_each_persistent_*`() for a convenient way to remove more than one item.  E.g.,</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *      `util::remove_each_persistent_with_name_prefix&lt;Pool_arena&gt;()` combines remove_persistent() and</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   *      for_each_persistent() in a common-sense way to remove only those `name`s starting with a given prefix;</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *      or simply all of them.</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   *</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   * Trying to remove a non-existent name *is* an error.</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   *</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">   * Logs INFO message.</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">   *</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">   * @warning The impl should be carefully checked to conform to this.  As of this writing the 2 relevant</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   *          low-level MQ APIs (bipc and POSIX) do, but there could be more.</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   *</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   *        Logger to use for subsequently logging.</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   * @param name</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   *        Absolute name at which the persistent MQ lives.</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   *        various.</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   */</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a2e8b8102fdbacc064d4759533a725f51">  351</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a2e8b8102fdbacc064d4759533a725f51">remove_persistent</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; name,</div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span>                                <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment"></span> </div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * Lists all named persistent MQs currently persisting, invoking the given handler synchronously on each one.</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   *</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * Note that, in a sanely set-up OS install, all existing pools will be listed by this function;</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * but permissions/ownership may forbid certain operations the user may typically want to invoke on</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * a given listed name -- for example remove_persistent().  This function does *not* filter-out any</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * potentially inaccessible items.</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   *</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * @tparam Handle_name_func</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *         Function object matching signature `void F(const Shared_name&amp;)`.</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   * @param handle_name_func</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   *        `handle_name_func()` shall be invoked for each (matching, if applicable) item.  See `Handle_name_func`.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   */</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handle_name_func&gt;</div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac14dd419cdbc97b6630900268f8b7dd2">  368</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac14dd419cdbc97b6630900268f8b7dd2">for_each_persistent</a>(<span class="keyword">const</span> Handle_name_func&amp; handle_name_func);</div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment"></span> </div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   * Non-blocking send: pushes copy of message to queue and returns `true`; if queue is full then no-op and returns</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   * `false`.  A null blob (`blob.size() == 0`) is allowed.</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   *</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * Exception to this: If `blob.size()` exceeds message size limit (if any), a particular error, which shall be</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * documented below, is emitted; this is not fatal to `*this`.</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   *</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   *        Buffer to copy into MQ; if empty then an empty message is pushed.</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   *        error::Code::S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW (excessive-size error: buffer exceeds</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   *        max_msg_size()).</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   * @return `true` on success; `false` on failure; in the latter case `*err_code` distinguishes</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   *         between would-block and fatal error.</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   */</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ad9d38e0e16931dd96738d53b787533a1">  388</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ad9d38e0e16931dd96738d53b787533a1">try_send</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment"></span> </div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   * Blocking send: pushes copy of message to queue; if queue is full blocks until it is not.</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * A null blob (`blob.size() == 0`) is allowed.</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   *</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * Exception to this: If `blob.size()` exceeds message size limit (if any), a particular error, which shall be</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   * documented below, is emitted; this is not fatal to `*this`.  Exception to this: interrupt_sends()</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   * leads to the emission of a particular error which shall be documented below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   *</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   *        See try_send().</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   *        error::Code::S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW (excessive-size error: buffer exceeds</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   *        max_msg_size()).</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_sends()).</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   */</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a9d54e47b729eec9f72dee869326bfa8f">  408</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a9d54e47b729eec9f72dee869326bfa8f">send</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment"></span> </div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   * Blocking timed send: pushes copy of message to queue; if queue is full blocks until it is not, or the</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   * specified time passes, whichever happens first.  Returns `true` on success; `false` on timeout or error.</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * A null blob (`blob.size() == 0`) is allowed.</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   *</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   * Exception to this: If `blob.size()` exceeds message size limit (if any), a particular error, which shall be</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   * documented below, is emitted; this is not fatal to `*this`.  Exception to this: interrupt_sends()</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   * leads to the emission of a particular error which shall be documented below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   *</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   * @warning The user must not count on precision/stability -- unlike with, say, boost.asio timers -- here.</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   *          If timing precision is required, the user will have to add an async layer with more precise timing</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   *          and not rely on this.  For example, informally, suggest: Use timed_send() with 250msec increments</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   *          to model an interruptible indefinitely-blocking send().  In a parallel thread, if it&#39;s time to</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   *          interrupt the modeled endless send(), set some flag that&#39;ll cause the 250msec-long attempts to cease.</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   *          The last one (that straddles the interruption point) can just be ignored.</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   *</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment">   *        See try_send().</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">   * @param timeout_from_now</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   *        Now + (this long) = the timeout time point.</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   *        various.  Would-block shall not be emitted.  Timeout shall not be emitted.</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   *        error::Code::S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW (excessive-size error: buffer exceeds</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   *        max_msg_size()).</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_sends()).</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   * @return `true` on success; `false` on failure; in the latter case `*err_code` distinguishes</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   *         between timeout and fatal error.</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   */</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ab4cba10b83df79acf76c64b0deb7f624">  440</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ab4cba10b83df79acf76c64b0deb7f624">timed_send</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; blob, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout_from_now, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment"></span> </div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   * Equivalent to try_send() except stops short of writing anything, with `true` result indicating that</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * try_send() *would* work at that moment.</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   *</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment">   * Exception to this: interrupt_sends() leads to the emission of a particular error which shall be documented</span></div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">   * below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">   *</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted by interrupt_sends()).</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   * @return `true` if transmissible; `false` if not, or on error.</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   */</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ab95e3d32a7ad3fa3630ba54442d8f2ee">  456</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ab95e3d32a7ad3fa3630ba54442d8f2ee">is_sendable</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment"></span> </div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="comment">   * Equivalent to send() except stops short of writing anything, with non-error return indicating that</span></div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment">   * try_send() *would* work at that moment.  It shall block indefinitely until fatal error, or</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">   * error::Code::S_INTERRUPTED, or transmissibility.</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">   *</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment">   * Exception to this: interrupt_sends() leads to the emission of a particular error which shall be documented</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">   * below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">   *</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_sends()).</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   */</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a230060aa545bfe11eb263211c84514f1">  472</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a230060aa545bfe11eb263211c84514f1">wait_sendable</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment"></span> </div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   * Equivalent to timed_send() except stops short of writing anything, with `true` result indicating that</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   * try_send() *would* work at that moment.  It shall block until fatal error, or</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   * error::Code::S_INTERRUPTED, or timeout, or transmissibility.</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   *</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   * Exception to this: interrupt_sends() leads to the emission of a particular error which shall be documented</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   * below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">   *</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">   * @param timeout_from_now</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">   *        See timed_send().</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_sends()).</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   * @return `true` if transmissible; `false` if not, or on error or timeout; in the latter case `*err_code`</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   *         distinguishes between timeout and fatal error.</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   */</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#aadfffb71ff2fec6508174fdf4b08327e">  492</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#aadfffb71ff2fec6508174fdf4b08327e">timed_wait_sendable</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout_from_now, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment"></span> </div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">   * Non-blocking receive: pops copy of message from queue into buffer and returns `true`; if queue is empty then no-op</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   * and returns `false`.  On `true` `blob-&gt;size()` is modified to store the # of bytes received.</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   * A null blob (`blob-&gt;size() == 0` post-condition) is possible.</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment">   *</span></div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">   * Exception to this: If `blob-&gt;size()` is less than the required message size (or upper limit on this, if any),</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">   * a particular error, which shall be documented below, is emitted; this is not fatal to `*this`.</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">   *</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   *        Buffer into which to copy into MQ and whose `-&gt;size()` to update to the # of bytes received;</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   *        if message empty it is set to zero.  Original `-&gt;size()` value indicates capacity of buffer;</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   *        if this is insufficient based on either the popped message size or an upper limit (if any), it is an error.</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   *        error::Code::S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW (size-underflow error: buffer is smaller than</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span><span class="comment">   *        max_msg_size()).</span></div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment">   * @return `true` on success; `false` on failure; in the latter case `*err_code` distinguishes</span></div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">   *         between would-block and fatal error.</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   */</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a84f802c77b0ce93d59e7ac78839f14cc">  515</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a84f802c77b0ce93d59e7ac78839f14cc">try_receive</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>* blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment"></span> </div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   * Blocking receive: pops copy of message from queue into buffer; if queue is empty blocks until it is not.</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   * On `true` `blob-&gt;size()` is modified to store the # of bytes received.</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   * A null blob (`blob-&gt;size() == 0` post-condition) is possible.</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   *</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment">   * Exception to this: If `blob-&gt;size()` is less than the required message size (or upper limit on this, if any),</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment">   * a particular error, which shall be documented below, is emitted; this is not fatal to `*this`.</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="comment">   * Exception to this: interrupt_receives()</span></div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment">   * leads to the emission of a particular error which shall be documented below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">   *</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   *        See try_receive().</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   *        error::Code::S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW (size-underflow error: buffer is smaller than</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   *        max_msg_size()).</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_receives()).</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   */</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae1e6822d16d30dc57c95e3e051e5f8a8">  537</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae1e6822d16d30dc57c95e3e051e5f8a8">receive</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>* blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment"></span> </div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">   * Blocking timed receive: pops copy of message from queue into buffer; if queue is empty blocks until it is not, or</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="comment">   * the specified time passes, whichever happens first.  Returns `true` on success; `false` on timeout or error.</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span><span class="comment">   * On `true` `blob-&gt;size()` is modified to store the # of bytes received.</span></div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment">   * A null blob (`blob-&gt;size() == 0` post-condition) is possible.</span></div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">   *</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">   * Exception to this: If `blob-&gt;size()` is less than the required message size (or upper limit on this, if any),</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   * a particular error, which shall be documented below, is emitted; this is not fatal to `*this`.</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   *</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   * @warning Read the warning on timed_send() about the accuracy of the timeout.  Same applies here.</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   *</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span><span class="comment">   *        See try_receive().</span></div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span><span class="comment">   * @param timeout_from_now</span></div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span><span class="comment">   *        Now + (this long) = the timeout time point.</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   *        various.  Would-block shall not be emitted.  Timeout shall not be emitted.</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   *        error::Code::S_MQ_MESSAGE_SIZE_OVER_OR_UNDERFLOW (size-underflow error: buffer is smaller than</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span><span class="comment">   *        max_msg_size()).</span></div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_receives()).</span></div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span><span class="comment">   * @return `true` on success; `false` on failure; in the latter case `*err_code` distinguishes</span></div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span><span class="comment">   *         between timeout and fatal error.</span></div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment">   */</span></div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af547b6f1b1e51a7d6f6fbafc14c95f9d">  564</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af547b6f1b1e51a7d6f6fbafc14c95f9d">timed_receive</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>* blob, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout_from_now, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment"></span> </div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   * Equivalent to try_receive() except stops short of reading anything, with `true` result indicating that</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   * try_receive() *would* work at that moment.</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="comment">   *</span></div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span><span class="comment">   * Exception to this: interrupt_receives() leads to the emission of a particular error which shall be documented</span></div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span><span class="comment">   * below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span><span class="comment">   *</span></div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted by interrupt_receives()).</span></div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span><span class="comment">   * @return `true` if transmissible; `false` if not, or on error.</span></div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span><span class="comment">   */</span></div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#acdf4279219020020b1d8b3ff8a80cbe2">  580</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#acdf4279219020020b1d8b3ff8a80cbe2">is_receivable</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment"></span> </div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span><span class="comment">   * Equivalent to receive() except stops short of reading anything, with non-error return indicating that</span></div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span><span class="comment">   * try_receive() *would* work at that moment.  It shall block indefinitely until fatal error, or</span></div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment">   * error::Code::S_INTERRUPTED, or transmissibility.</span></div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">   *</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">   * Exception to this: interrupt_receives() leads to the emission of a particular error which shall be documented</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span><span class="comment">   * below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span><span class="comment">   *</span></div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_receives()).</span></div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span><span class="comment">   */</span></div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a7029f9601aa268022bd8cf7970c512c8">  596</a></span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a7029f9601aa268022bd8cf7970c512c8">wait_receivable</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment"></span> </div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">   * Equivalent to timed_receive() except stops short of reading anything, with `true` result indicating that</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">   * try_receive() *would* work at that moment.  It shall block until fatal error, or</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   * error::Code::S_INTERRUPTED, or timeout, or transmissibility.</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">   *</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">   * If error is emitted, `*this` shall be considered hosed: Behavior is undefined except dtor or move-assignment.</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">   * Exception to this: interrupt_receives() leads to the emission of a particular error which shall be documented</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   * below; this is not fatal to `*this.</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span><span class="comment">   *</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span><span class="comment">   * @param timeout_from_now</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span><span class="comment">   *        See timed_receive().</span></div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span><span class="comment">   *        various.  Would-block shall not be emitted.</span></div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment">   *        error::Code::S_INTERRUPTED (preempted or interrupted by interrupt_receives()).</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">   * @return `true` if transmissible; `false` if not, or on error or timeout; in the latter case `*err_code`</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span><span class="comment">   *         distinguishes between timeout and fatal error.</span></div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span><span class="comment">   */</span></div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac4f13853e38ade577faabbf9ef0af74f">  616</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac4f13853e38ade577faabbf9ef0af74f">timed_wait_receivable</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout_from_now, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment"></span> </div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span><span class="comment">   * Enables sends-interrupted mode: is_sendable() (future calls), send() (future or concurrent calls),</span></div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment">   * timed_send() (ditto), wait_sendable() (ditto), timed_wait_sendable() (ditto) shall emit</span></div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">   * error::Code::S_INTERRUPTED as soon as possible.</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">   *</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">   * @return `true` on success; `false` is already enabled.</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span><span class="comment">   */</span></div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af7a883553df39b16047b49942bd734c0">  625</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af7a883553df39b16047b49942bd734c0">interrupt_sends</a>();</div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span><span class="comment"></span> </div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span><span class="comment">   * Disables mode enabled by interrupt_sends().</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span><span class="comment">   *</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span><span class="comment">   * @return `true` on success; `false` if already disabled.</span></div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span><span class="comment">   */</span></div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af43b22d89c5a228c2a72c321c2e24545">  632</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#af43b22d89c5a228c2a72c321c2e24545">allow_sends</a>();</div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span><span class="comment"></span> </div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span><span class="comment">   * Enables receives-interrupted mode: is_receivable() (future calls), receive() (future or concurrent calls),</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span><span class="comment">   * timed_receive() (ditto), wait_receivable() (ditto), timed_wait_receivable() (ditto) shall emit</span></div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span><span class="comment">   * error::Code::S_INTERRUPTED as soon as possible.</span></div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span><span class="comment">   *</span></div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span><span class="comment">   * @return `true` on success; `false` is already enabled.</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span><span class="comment">   */</span></div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a206333d3eb619588d17812f8f49013a2">  641</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a206333d3eb619588d17812f8f49013a2">interrupt_receives</a>();</div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span><span class="comment"></span> </div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span><span class="comment">   * Disables mode enabled by interrupt_receives().</span></div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span><span class="comment">   *</span></div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span><span class="comment">   * @return `true` on success; `false` if already disabled.</span></div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span><span class="comment">   */</span></div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#aaedc972e2ce207875a3e7262f9064b65">  648</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#aaedc972e2ce207875a3e7262f9064b65">allow_receives</a>();</div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span><span class="comment"></span> </div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span><span class="comment">   * Returns name equal to `absolute_name` passed to ctor.</span></div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment">   */</span></div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">  654</a></span>  <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">absolute_name</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment"></span> </div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   * Returns the max message size of the underlying queue.  This should at least approximately equal</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">   * what was passed to ctor when creating the MQ; however the underlying transport may tweak it, such as rounding</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span><span class="comment">   * to page size.</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span><span class="comment">   *</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">   */</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae2efe92707c53c46bc70b84f96bda217">  663</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae2efe92707c53c46bc70b84f96bda217">max_msg_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span><span class="comment"></span> </div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span><span class="comment">   * Returns the max message count of the underlying queue.  This should at least approximately equal</span></div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span><span class="comment">   * what was passed to ctor when creating the MQ; however the underlying transport may tweak it if it desires.</span></div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span><span class="comment">   *</span></div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="comment">   */</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a22575a5750d322ccf87a923a3d662756">  671</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a22575a5750d322ccf87a923a3d662756">max_n_msgs</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span><span class="comment"></span> </div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno">  674</span><span class="comment">   * Available if and only if #S_HAS_NATIVE_HANDLE is `true`: Returns the stored native MQ handle; null means a</span></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span><span class="comment">   * constructor failed, or `*this` has been moved-from, hence the handle is to not-a-queue.</span></div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span><span class="comment">   * See class doc header for important background discussion w/r/t the rationale behind this method.</span></div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span><span class="comment">   *</span></div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span><span class="comment">   * Medium-length story short: this is (in Linux impl of POSIX MQ) really an FD and as such can</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span><span class="comment">   * be wrapped via `boost::asio::posix::descriptor` and hence participate</span></div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span><span class="comment">   * in a `Task_engine` event loop which internally will use `epoll()` together with all the other waited-on</span></div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span><span class="comment">   * resources; or simply be `poll()`ed (etc.).  E.g., boost.asio `async_wait()` for readability;</span></div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span><span class="comment">   * then invoke `this-&gt;try_receive()` once it is readable.</span></div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span><span class="comment">   *</span></div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span><span class="comment">   * Behavior is undefined if you operate on this value, such as sending or receiving, concurrently to any</span></div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span><span class="comment">   * transmission APIs acting on `*this`.</span></div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span><span class="comment">   *</span></div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span><span class="comment">   * @note It is possible to get away with not using this by using the `*_sendable()` and `*_receivable()`</span></div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span><span class="comment">   *       methods.  However the blocking and timed variations cannot be straightforwardly interrupted.</span></div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span><span class="comment">   *</span></div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span><span class="comment">   */</span></div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a25e96c4f060cc3c4b611c4e2de60abaf">  692</a></span>  <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a25e96c4f060cc3c4b611c4e2de60abaf">native_handle</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span>}; <span class="comment">// class Persistent_mq_handle</span></div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span> </div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span><span class="comment"></span> </div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span><span class="comment">/**</span></div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span><span class="comment"> * Swaps two objects.  Constant-time.  Suitable for standard ADL-swap pattern `using std::swap; swap(val1, val2);`.</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span><span class="comment"> *</span></div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span><span class="comment"> * @relatesalso Persistent_mq_handle</span></div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment"> *</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span><span class="comment"> * @param val1</span></div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span><span class="comment"> *        Object.</span></div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span><span class="comment"> * @param val2</span></div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span><span class="comment"> *        Object.</span></div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span><span class="comment"> */</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a6f670a864f39c533a6a98dbca8fdb224">  707</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a6f670a864f39c533a6a98dbca8fdb224">swap</a>(<a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp; val1, <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&amp; val2);</div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span> </div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span>} <span class="comment">// namespace ipc::transport</span></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html">ipc::transport::Persistent_mq_handle</a></div><div class="ttdoc">A documentation-only concept defining the behavior of an object representing a light-weight handle to...</div><div class="ttdef"><b>Definition:</b> <a href="persistent__mq__handle_8hpp_source.html#l00194">persistent_mq_handle.hpp:195</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a1fbb936f8f80fedcb1227794ef0a451b"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a1fbb936f8f80fedcb1227794ef0a451b">ipc::transport::Persistent_mq_handle::~Persistent_mq_handle</a></div><div class="ttdeci">~Persistent_mq_handle()</div><div class="ttdoc">Destroys this handle (or no-op if no handle was successfully constructed, or if it's a moved-from or ...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a206333d3eb619588d17812f8f49013a2"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a206333d3eb619588d17812f8f49013a2">ipc::transport::Persistent_mq_handle::interrupt_receives</a></div><div class="ttdeci">bool interrupt_receives()</div><div class="ttdoc">Enables receives-interrupted mode: is_receivable() (future calls), receive() (future or concurrent ca...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a22575a5750d322ccf87a923a3d662756"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a22575a5750d322ccf87a923a3d662756">ipc::transport::Persistent_mq_handle::max_n_msgs</a></div><div class="ttdeci">size_t max_n_msgs() const</div><div class="ttdoc">Returns the max message count of the underlying queue.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a22abfaa801a9e2f974a8cd179544d19a"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a22abfaa801a9e2f974a8cd179544d19a">ipc::transport::Persistent_mq_handle::Persistent_mq_handle</a></div><div class="ttdeci">Persistent_mq_handle()</div><div class="ttdoc">Construct null handle, suitable only for being subsequently moved-to or destroyed.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a230060aa545bfe11eb263211c84514f1"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a230060aa545bfe11eb263211c84514f1">ipc::transport::Persistent_mq_handle::wait_sendable</a></div><div class="ttdeci">void wait_sendable(Error_code *err_code=0)</div><div class="ttdoc">Equivalent to send() except stops short of writing anything, with non-error return indicating that tr...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a25e96c4f060cc3c4b611c4e2de60abaf"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a25e96c4f060cc3c4b611c4e2de60abaf">ipc::transport::Persistent_mq_handle::native_handle</a></div><div class="ttdeci">Native_handle native_handle() const</div><div class="ttdoc">Available if and only if S_HAS_NATIVE_HANDLE is true: Returns the stored native MQ handle; null means...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a2e8b8102fdbacc064d4759533a725f51"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a2e8b8102fdbacc064d4759533a725f51">ipc::transport::Persistent_mq_handle::remove_persistent</a></div><div class="ttdeci">static void remove_persistent(flow::log::Logger *logger_ptr, const Shared_name &amp;name, Error_code *err_code=0)</div><div class="ttdoc">Removes the named persistent MQ.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a30b2d1fdc3cae55c9c1fe8a1014247ff"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a30b2d1fdc3cae55c9c1fe8a1014247ff">ipc::transport::Persistent_mq_handle::operator=</a></div><div class="ttdeci">Persistent_mq_handle &amp; operator=(Persistent_mq_handle &amp;&amp;src)</div><div class="ttdoc">Replaces handle with the source handle while making the latter invalid.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a341076bd3ac7e32e4d1fa12570a11fd2"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a341076bd3ac7e32e4d1fa12570a11fd2">ipc::transport::Persistent_mq_handle::Persistent_mq_handle</a></div><div class="ttdeci">Persistent_mq_handle(flow::log::Logger *logger_ptr, const Shared_name &amp;absolute_name, util::Create_only mode_tag, size_t max_n_msg, size_t max_msg_sz, const util::Permissions &amp;perms=util::Permissions(), Error_code *err_code=0)</div><div class="ttdoc">Construct handle to non-existing named MQ, creating it first.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a5ef74ca74a9d985710af974fd6518940"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">ipc::transport::Persistent_mq_handle::absolute_name</a></div><div class="ttdeci">const Shared_name &amp; absolute_name() const</div><div class="ttdoc">Returns name equal to absolute_name passed to ctor.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a65d294e8972436e1193fe02baa34b20d"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a65d294e8972436e1193fe02baa34b20d">ipc::transport::Persistent_mq_handle::Persistent_mq_handle</a></div><div class="ttdeci">Persistent_mq_handle(Persistent_mq_handle &amp;&amp;src)</div><div class="ttdoc">Constructs handle from the source handle while making the latter invalid.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a6f670a864f39c533a6a98dbca8fdb224"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a6f670a864f39c533a6a98dbca8fdb224">ipc::transport::Persistent_mq_handle::swap</a></div><div class="ttdeci">void swap(Persistent_mq_handle &amp;val1, Persistent_mq_handle &amp;val2)</div><div class="ttdoc">Swaps two objects.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a7029f9601aa268022bd8cf7970c512c8"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a7029f9601aa268022bd8cf7970c512c8">ipc::transport::Persistent_mq_handle::wait_receivable</a></div><div class="ttdeci">void wait_receivable(Error_code *err_code=0)</div><div class="ttdoc">Equivalent to receive() except stops short of reading anything, with non-error return indicating that...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a84f802c77b0ce93d59e7ac78839f14cc"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a84f802c77b0ce93d59e7ac78839f14cc">ipc::transport::Persistent_mq_handle::try_receive</a></div><div class="ttdeci">bool try_receive(util::Blob_mutable *blob, Error_code *err_code=0)</div><div class="ttdoc">Non-blocking receive: pops copy of message from queue into buffer and returns true; if queue is empty...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a9d54e47b729eec9f72dee869326bfa8f"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a9d54e47b729eec9f72dee869326bfa8f">ipc::transport::Persistent_mq_handle::send</a></div><div class="ttdeci">void send(const util::Blob_const &amp;blob, Error_code *err_code=0)</div><div class="ttdoc">Blocking send: pushes copy of message to queue; if queue is full blocks until it is not.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_aadfffb71ff2fec6508174fdf4b08327e"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#aadfffb71ff2fec6508174fdf4b08327e">ipc::transport::Persistent_mq_handle::timed_wait_sendable</a></div><div class="ttdeci">bool timed_wait_sendable(util::Fine_duration timeout_from_now, Error_code *err_code=0)</div><div class="ttdoc">Equivalent to timed_send() except stops short of writing anything, with true result indicating that t...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_aaedc972e2ce207875a3e7262f9064b65"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#aaedc972e2ce207875a3e7262f9064b65">ipc::transport::Persistent_mq_handle::allow_receives</a></div><div class="ttdeci">bool allow_receives()</div><div class="ttdoc">Disables mode enabled by interrupt_receives().</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ab4cba10b83df79acf76c64b0deb7f624"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ab4cba10b83df79acf76c64b0deb7f624">ipc::transport::Persistent_mq_handle::timed_send</a></div><div class="ttdeci">bool timed_send(const util::Blob_const &amp;blob, util::Fine_duration timeout_from_now, Error_code *err_code=0)</div><div class="ttdoc">Blocking timed send: pushes copy of message to queue; if queue is full blocks until it is not,...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ab95e3d32a7ad3fa3630ba54442d8f2ee"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ab95e3d32a7ad3fa3630ba54442d8f2ee">ipc::transport::Persistent_mq_handle::is_sendable</a></div><div class="ttdeci">bool is_sendable(Error_code *err_code=0)</div><div class="ttdoc">Equivalent to try_send() except stops short of writing anything, with true result indicating that try...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ac14dd419cdbc97b6630900268f8b7dd2"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac14dd419cdbc97b6630900268f8b7dd2">ipc::transport::Persistent_mq_handle::for_each_persistent</a></div><div class="ttdeci">static void for_each_persistent(const Handle_name_func &amp;handle_name_func)</div><div class="ttdoc">Lists all named persistent MQs currently persisting, invoking the given handler synchronously on each...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ac2c0b560893c6a8b71aac0e748770076"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac2c0b560893c6a8b71aac0e748770076">ipc::transport::Persistent_mq_handle::S_HAS_NATIVE_HANDLE</a></div><div class="ttdeci">static constexpr bool S_HAS_NATIVE_HANDLE</div><div class="ttdoc">true if and only if native_handle() method exists, and the returned value may be waited-on by poll()/...</div><div class="ttdef"><b>Definition:</b> <a href="persistent__mq__handle_8hpp_source.html#l00203">persistent_mq_handle.hpp:203</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ac4f13853e38ade577faabbf9ef0af74f"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac4f13853e38ade577faabbf9ef0af74f">ipc::transport::Persistent_mq_handle::timed_wait_receivable</a></div><div class="ttdeci">bool timed_wait_receivable(util::Fine_duration timeout_from_now, Error_code *err_code=0)</div><div class="ttdoc">Equivalent to timed_receive() except stops short of reading anything, with true result indicating tha...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_acdf4279219020020b1d8b3ff8a80cbe2"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#acdf4279219020020b1d8b3ff8a80cbe2">ipc::transport::Persistent_mq_handle::is_receivable</a></div><div class="ttdeci">bool is_receivable(Error_code *err_code=0)</div><div class="ttdoc">Equivalent to try_receive() except stops short of reading anything, with true result indicating that ...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ad49e1049101a5ab6cfb2ed2b3eaedee0"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ad49e1049101a5ab6cfb2ed2b3eaedee0">ipc::transport::Persistent_mq_handle::S_RESOURCE_TYPE_ID</a></div><div class="ttdeci">static const Shared_name S_RESOURCE_TYPE_ID</div><div class="ttdoc">Shared_name relative-folder fragment (no separators) identifying this resource type.</div><div class="ttdef"><b>Definition:</b> <a href="persistent__mq__handle_8hpp_source.html#l00200">persistent_mq_handle.hpp:200</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ad9d38e0e16931dd96738d53b787533a1"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ad9d38e0e16931dd96738d53b787533a1">ipc::transport::Persistent_mq_handle::try_send</a></div><div class="ttdeci">bool try_send(const util::Blob_const &amp;blob, Error_code *err_code=0)</div><div class="ttdoc">Non-blocking send: pushes copy of message to queue and returns true; if queue is full then no-op and ...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ae1e6822d16d30dc57c95e3e051e5f8a8"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae1e6822d16d30dc57c95e3e051e5f8a8">ipc::transport::Persistent_mq_handle::receive</a></div><div class="ttdeci">void receive(util::Blob_mutable *blob, Error_code *err_code=0)</div><div class="ttdoc">Blocking receive: pops copy of message from queue into buffer; if queue is empty blocks until it is n...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ae2efe92707c53c46bc70b84f96bda217"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae2efe92707c53c46bc70b84f96bda217">ipc::transport::Persistent_mq_handle::max_msg_size</a></div><div class="ttdeci">size_t max_msg_size() const</div><div class="ttdoc">Returns the max message size of the underlying queue.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_ae58b5d8b275dc364a0abeaf36c6a4534"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae58b5d8b275dc364a0abeaf36c6a4534">ipc::transport::Persistent_mq_handle::Persistent_mq_handle</a></div><div class="ttdeci">Persistent_mq_handle(const Persistent_mq_handle &amp;)=delete</div><div class="ttdoc">Copying of handles is prohibited.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_af19038ecd7b1ab5b579d011345cef62b"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#af19038ecd7b1ab5b579d011345cef62b">ipc::transport::Persistent_mq_handle::operator=</a></div><div class="ttdeci">Persistent_mq_handle &amp; operator=(const Persistent_mq_handle &amp;)=delete</div><div class="ttdoc">Copying of handles is prohibited.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_af20035c875572ed018427322c845b9f9"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#af20035c875572ed018427322c845b9f9">ipc::transport::Persistent_mq_handle::Persistent_mq_handle</a></div><div class="ttdeci">Persistent_mq_handle(flow::log::Logger *logger_ptr, const Shared_name &amp;absolute_name, util::Open_or_create mode_tag, size_t max_n_msg_on_create, size_t max_msg_sz_on_create, const util::Permissions &amp;perms_on_create=util::Permissions(), Error_code *err_code=0)</div><div class="ttdoc">Construct handle to existing named MQ, or else if it does not exist creates it first and opens it (at...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_af43b22d89c5a228c2a72c321c2e24545"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#af43b22d89c5a228c2a72c321c2e24545">ipc::transport::Persistent_mq_handle::allow_sends</a></div><div class="ttdeci">bool allow_sends()</div><div class="ttdoc">Disables mode enabled by interrupt_sends().</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_af547b6f1b1e51a7d6f6fbafc14c95f9d"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#af547b6f1b1e51a7d6f6fbafc14c95f9d">ipc::transport::Persistent_mq_handle::timed_receive</a></div><div class="ttdeci">bool timed_receive(util::Blob_mutable *blob, util::Fine_duration timeout_from_now, Error_code *err_code=0)</div><div class="ttdoc">Blocking timed receive: pops copy of message from queue into buffer; if queue is empty blocks until i...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_af74d564d34874d1b86c043dfb7406048"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#af74d564d34874d1b86c043dfb7406048">ipc::transport::Persistent_mq_handle::Persistent_mq_handle</a></div><div class="ttdeci">Persistent_mq_handle(flow::log::Logger *logger_ptr, const Shared_name &amp;absolute_name, util::Open_only mode_tag, Error_code *err_code=0)</div><div class="ttdoc">Construct handle to existing named MQ.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_af7a883553df39b16047b49942bd734c0"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#af7a883553df39b16047b49942bd734c0">ipc::transport::Persistent_mq_handle::interrupt_sends</a></div><div class="ttdeci">bool interrupt_sends()</div><div class="ttdoc">Enables sends-interrupted mode: is_sendable() (future calls), send() (future or concurrent calls),...</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_html"><div class="ttname"><a href="namespaceipc_1_1transport.html">ipc::transport</a></div><div class="ttdoc">Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...</div><div class="ttdef"><b>Definition:</b> <a href="asio__local__stream__socket_8cpp_source.html#l00031">asio_local_stream_socket.cpp:32</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a1b398ae730d1e6040687cb2397115152"><div class="ttname"><a href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">ipc::util::Permissions</a></div><div class="ttdeci">bipc::permissions Permissions</div><div class="ttdoc">Short-hand for Unix (POSIX) permissions class.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00161">util_fwd.hpp:161</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a3e03491b5b2b5fac26551a220946d6e5"><div class="ttname"><a href="namespaceipc_1_1util.html#a3e03491b5b2b5fac26551a220946d6e5">ipc::util::Open_only</a></div><div class="ttdeci">bipc::open_only_t Open_only</div><div class="ttdoc">Tag type indicating an ideally-atomic open-if-exists-else-fail operation.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00155">util_fwd.hpp:155</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6cb62ae434900f3a8915b33ec5d61a96"><div class="ttname"><a href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">ipc::util::Blob_mutable</a></div><div class="ttdeci">boost::asio::mutable_buffer Blob_mutable</div><div class="ttdoc">Short-hand for an mutable blob somewhere in memory, stored as exactly a void* and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00140">util_fwd.hpp:140</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a9571de958538d7a4a8649bbfecfac0b9"><div class="ttname"><a href="namespaceipc_1_1util.html#a9571de958538d7a4a8649bbfecfac0b9">ipc::util::Open_or_create</a></div><div class="ttdeci">bipc::open_or_create_t Open_or_create</div><div class="ttdoc">Tag type indicating an atomic open-if-exists-else-create operation.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00152">util_fwd.hpp:152</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a9d84c2bab504e6de32b20c77ca9723a2"><div class="ttname"><a href="namespaceipc_1_1util.html#a9d84c2bab504e6de32b20c77ca9723a2">ipc::util::Create_only</a></div><div class="ttdeci">bipc::create_only_t Create_only</div><div class="ttdoc">Tag type indicating a create-unless-exists-else-fail operation.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00158">util_fwd.hpp:158</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ac66141280c3b7295a86b65209f31cc58"><div class="ttname"><a href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">ipc::util::Fine_duration</a></div><div class="ttdeci">flow::Fine_duration Fine_duration</div><div class="ttdoc">Short-hand for Flow's Fine_duration.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00117">util_fwd.hpp:117</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae0be7edba7e30ffa3f8b742af621f2ab"><div class="ttname"><a href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">ipc::util::Blob_const</a></div><div class="ttdeci">boost::asio::const_buffer Blob_const</div><div class="ttdoc">Short-hand for an immutable blob somewhere in memory, stored as exactly a void const * and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00134">util_fwd.hpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
